home *** CD-ROM | disk | FTP | other *** search
/ Aminet 38 / Aminet 38 (2000)(Schatztruhe)[!][Aug 2000].iso / Aminet / dev / asm / AmigaGS-Dev.lha / AmigaGS / Docs / FullDocEnglish.Asc next >
Encoding:
Text File  |  2000-04-26  |  8.2 KB  |  351 lines
  1. ; *************************************************
  2. ; *                                               *
  3. ; *     AMIGA GAME STUDIO DEVELOPMENT PROJECT     *
  4. ; *                                               *
  5. ; *-----------------------------------------------*
  6. ; *                                               *
  7. ; *  List for all functions defined in libraries  *
  8. ; * given in AmigaGS archive :                    *AmigaGS:
  9. ; *                                               *--------
  10. ; * Display???.Library         ECS/AGA  Ver : 1.0 *  0.1a
  11. ; * Chunky???.Library   CPU020/CPU040   Ver : 1.0 *  0.1a
  12. ; * Ilbm.Library                        Ver : 1.0 *  0.1a
  13. ; * Joystick.Library                    Ver : 1.0 *  0.1a
  14. ; * MemoryBanks.Library                 Ver : 1.0 *  0.1a
  15. ; * MemoryCopy???.Library      CPU020   Ver : 1.0 *  0.1a
  16. ; * Screens???.Library         ECS/AGA  Ver : 1.0 *  0.1a
  17. ; * FileIO.library                      Ver : 1.0 *  0.1c
  18. ; *                                               *
  19. ; *************************************************
  20. ; DATE : 26.April.2000 18:06 FRANCE
  21. ; Project Version 0.1c
  22. ;
  23. NOTE:
  24.     I'm sorry but AGAIcons.library is not documented because
  25.     she's not finished.She will be in next release.
  26. ;
  27. ; *******************
  28. ; *                 *
  29. ; * Display.Library *
  30. ; *                 *
  31. ; *******************
  32. ;
  33. 1 / Ags_Display :
  34. -----------------
  35.         In        :    /
  36.         Out        :    /
  37.         Help    :    Activate AmigaGS display instead of workbench
  38.                     
  39. 2 / WB_Display :
  40. ----------------
  41.         In        :    /
  42.         Out        :    /
  43.         Help    :    restore workbench display.
  44.  
  45. 3 / Ags_WaitVbl :
  46. -----------------
  47.         In        :    /
  48.         Out        :    /
  49.         Help    :    Wait for vertical refresh.
  50.  
  51. 4 / Ags_Screen :
  52. ----------------
  53.         In        :    A0=ScreenBase
  54.         Out        :    /
  55.         Help    :    Display any screen created with any of the
  56.                     "screens???.library"
  57.  
  58. 5 / Ags_SetColor :
  59. ------------------
  60.         In        :    D0=Color / D1=Red / D2=Green / D3=Blue
  61.         Out        :    /
  62.         Help    :    Define a 24bits color for AmigaGS display.
  63.  
  64. 6 / Ags_Copper:
  65. ---------------
  66.         In        :    /
  67.         Out        :    A0=AGS-CopperBase
  68.         Help    :    Give you the adress where the AmigaGS copper
  69.                     list is installed.
  70.  
  71. 7 / Refresh_Copper :
  72. --------------------
  73.         In        :    /
  74.         Out        :    /
  75.         Help    :    Send you back to AmigaGS Display.
  76.  
  77. 8 / Screen_Offset :
  78. -------------------
  79.         In        :    D0=XOffset / D1=YOffset
  80.         Out        :    /
  81.         Help    :    Make a scrolling for the screen installed in
  82.                     AmigaGS Display.
  83.  
  84. 9 / YDisplaySize :
  85. ------------------
  86.         In        :    D0=Y Screen Display Size
  87.         Out        :    /
  88.         Help    :    Make Y screen display bigger ( or smaller )
  89.                     than 192 pixels.
  90.  
  91. ;
  92. ; ******************
  93. ; *                *
  94. ; * Chunky.Library *
  95. ; *                *
  96. ; ******************
  97. ;
  98. You can select 68020 or 68040+ version making these :
  99. 1 / Select 68020 Ver : Rename Chunky020.library to chunkycpu.library
  100. 2 / Select 68040+ Ver : Rename Chunky040.library to chunkycpu.library
  101. ;
  102.  
  103. 1 / Set_ChunkyBase :
  104. --------------------
  105.         In        :    A0=Chunky_ScreenBase
  106.         Out        :    /
  107.         Help    :    Define where your chunky screen is located in
  108.                     any kind of memory.
  109.  
  110. 2 / Set_ScreenBase :
  111. --------------------
  112.         In        :    A0=Planar_ScreenBase
  113.         Out        :    /
  114.         Help    :    Define where your planar screen is located in
  115.                     chip memory.
  116.                     ( all planes must be allocated contiguously)
  117.  
  118. 3 / Set_ChunkySize :
  119. --------------------
  120.         In        :    D0=XSize / D1=YSize
  121.         Out        :    /
  122.         Help    :    Define The sizes of your chunky screen.
  123.                     There are only 2 values available :
  124.                     D0=320 / D1=200 or D0=160 / D1=100
  125.  
  126. 4 / ChunkyConvert :
  127. -------------------
  128.         In        :    /
  129.         Out        :    /
  130.         Help    :    convert the graphics contained inside chunky
  131.                     screen to your planar screen.
  132.  
  133. 5 / ChunkyPlot :
  134. ----------------
  135.         In        :    D0=XPos(0-319) / D1=YPos(0-199) / D2=Ink(0-255)
  136.         Out        :    /
  137.         Help    :    Draw a point inside chunky screen.
  138.  
  139. ;
  140. ; ****************
  141. ; *              *
  142. ; * Ilbm.Library *
  143. ; *              *
  144. ; ****************
  145. ;
  146.  
  147. 1 / IlbmConvert :
  148. -----------------
  149.         In        :    A0=ScreenBase / A1=IffBase
  150.         Out        :    /
  151.         Help    :    Convert a previously loaded in memory IFF/ILBM
  152.                     file into an AmigaGS Screen.
  153.  
  154. 2 / IlbmXSize :
  155. ---------------
  156.         In        :    A0=IffBase
  157.         Out        :    D0=XSize
  158.         Help    :    Give you the X size of an IFF/ILBM Picture
  159.                     in memory.
  160.  
  161. 3 / IlbmYSize :
  162. ---------------
  163.         In        :    A0=IffBase
  164.         Out        :    D0=YSize
  165.         Help    :    Give you the Y size of an IFF/ILBM Picture
  166.                     in memory.
  167.  
  168. 4 / IlbmDepth :
  169. ---------------
  170.         In        :    A0=IffBase
  171.         Out        :    D0=Depth
  172.         Help    :    Give you how many bitplanes the IFF/ILBM picture
  173.                     loaded in memory use.
  174.  
  175. 5 / IlbmPalette :
  176. -----------------
  177.         In        :    A0=IffBase
  178.         Out        :    A1=CMAP Base
  179.         Help    :    Give you the Adress of the color palette inside
  180.                     The IFF/ILBM picture.
  181.  
  182. ;
  183. ; ********************
  184. ; *                  *
  185. ; * Joystick.Library *
  186. ; *                  *
  187. ; ********************
  188. ;
  189.                     
  190. 1 / Joy0State :
  191. ---------------
  192.         In        :    /
  193.         Out        :    D0=Joystick state
  194.         Help    :    Give you the state of any joystick connected to
  195.                     your mouse port (0).
  196.                     Bits in D0 are organized like this :
  197.                         Bit 0 = True -> Direction is UP
  198.                         Bit 1 = True -> Direction is DOWN
  199.                         Bit 2 = True -> Direction is LEFT
  200.                         Bit 3 = True -> Direction is RIGHT
  201.  
  202. 2 / Joy1State :
  203. ---------------
  204.         In        :    /
  205.         Out        :    D0=Joystick state
  206.         Help    :    Give you the state of any joystick connected to
  207.                     your joystick port (1).
  208.                     Bits in D0 are organized like this :
  209.                         Bit 0 = True -> Direction is UP
  210.                         Bit 1 = True -> Direction is DOWN
  211.                         Bit 2 = True -> Direction is LEFT
  212.                         Bit 3 = True -> Direction is RIGHT
  213.  
  214. 3 / Joy0Fire?State :
  215. --------------------
  216.         In        :    /
  217.         Out        :    D0=Button state
  218.         Help    :    Give you the state of any button of a joystick
  219.                     OR mouse connected to mouse port (0).
  220.                     You can check buttons 1,2 and 3.
  221.  
  222. 4 / Joy1Fire?State :
  223. --------------------
  224.         In        :    /
  225.         Out        :    D0=Button state
  226.         Help    :    Give you the state of any button of a joystick
  227.                     OR mouse connected to joystick port (1).
  228.                     You can check buttons 1,2 and 3.
  229.  
  230. 5 / ArrowsKeysState :
  231. ---------------------
  232.         In        :    /
  233.         Out        :    D0=Arrow key pressed .
  234.         Help    :    Tell you if any of 4 directions arrows keys has
  235.                     just been pushed.
  236.  
  237. ;
  238. ; ***********************
  239. ; *                     *
  240. ; * MemoryBanks.Library *
  241. ; *                     *
  242. ; ***********************
  243. ;
  244.  
  245. 1 / ReserveAsChipData :
  246. -----------------------
  247.         In        :    D0=Bank / D1=Size (in bytes)
  248.         Out        :    A0=BankBase
  249.         Help    :    Try to allocate memory from Chip-RAM
  250.  
  251. 2 / ReserveAsFastData :
  252. -----------------------
  253.         In        :    D0=Bank / D1=Size (in bytes)
  254.         Out        :    A0=BankBase
  255.         Help    :    Try to allocate memory from Fast-RAM
  256.  
  257. 3 / ReserveAsPublicData :
  258. -------------------------
  259.         In        :    D0=Bank / D1=Size (in bytes)
  260.         Out        :    A0=BankBase
  261.         Help    :    Try to allocate memory from Public-RAM type.
  262.  
  263. 4 / ReserveAs24BitDMAData :
  264. ---------------------------
  265.         In        :    D0=Bank / D1=Size (in bytes)
  266.         Out        :    A0=BankBase
  267.         Help    :    Try to allocate 24Bit DMA-Able memory.
  268.  
  269. 5 / BankBase :
  270. --------------
  271.         In        :    D0=Bank
  272.         Out        :    A0=BankBase
  273.         Help    :    Tell you where a bank is located in memory.
  274.  
  275. 6 / EraseBank :
  276. ---------------
  277.         In        :    D0=Bank
  278.         Out        :    /
  279.         Help    :    Erase a previously allocated memory bank.
  280.  
  281. 7 / EraseAllBanks :
  282. -------------------
  283.         In        :    /
  284.         Out        :    /
  285.         Help    :    Erase all previously allocated memory banks.
  286.  
  287. ;
  288. ; **********************
  289. ; *                    *
  290. ; * MemoryCOPY.Library *
  291. ; *                    *
  292. ; **********************
  293. ;
  294. 1 / MemoryClear :
  295. -----------------
  296.         In        :    A0=MemoryAdress / D0=Size (in bytes)
  297.         Out        :    /
  298.         Help    :    Clear a zone of memory.
  299.  
  300. 2 / MemoryCopy :
  301. ----------------
  302.         In        :    A0=Source / A1=Target / D0=Size (in bytes)
  303.         Out        :    /
  304.         Help    :    Copy D0 bytes from A0 memory zone to A1 memory
  305.                     zone.
  306.  
  307. ;
  308. ; *******************
  309. ; *                 *
  310. ; * Screens.Library *
  311. ; *                 *
  312. ; *******************
  313. ;
  314.  
  315. 1 / Screen_Open :
  316. -----------------
  317.         In        :    D0=Screen / D1=XSize / D2=YSize / D3=Depth
  318.         Out        :    /
  319.         Help    :    Open a screen using D3 bitplanes.
  320.  
  321. 2 / Screen_Close :
  322. ------------------
  323.         In        :    D0=Screen
  324.         Out        :    /
  325.         Help    :    Close a previously opened screen.
  326.  
  327. 3 / Screen_Base :
  328. -----------------
  329.         In        :    D0=Screen
  330.         Out        :    A0=ScreenBase
  331.         Help    :    Give you where a screen is located.
  332.  
  333. ;
  334. ; ******************
  335. ; *                *
  336. ; * FileIO.Library *
  337. ; *                *
  338. ; ******************
  339. ;
  340.  
  341. 1 / LoadFile :
  342. --------------
  343.         In        :    A0=FileName , A1=Target Adress , D0=FileSize
  344.         Out        :    /
  345.         Help    :    Load a file in memory starting at A1.
  346.  
  347. 2 / SaveFile :
  348. --------------
  349.         In        :    A0=FileName , A1=Source Adress , D0=FileSize
  350.         Out        :    /
  351.         Help    :    Save a file on disk from memory start is A1.